Incorporate feedback
Dominik Sander
9 changed files with 27 additions and 18 deletions
+ 4
- 3
.env.example
@@ -176,9 +176,10 @@ DELAYED_JOB_MAX_RUNTIME=2 |
||
| 176 | 176 |
# Amount of seconds for delayed_job to sleep before checking for new jobs |
| 177 | 177 |
DELAYED_JOB_SLEEP_DELAY=10 |
| 178 | 178 |
|
| 179 |
-########################################################## |
|
| 180 |
-# Capistrano deployment (read the documentation FIXME) # |
|
| 181 |
-########################################################## |
|
| 179 |
+############################################################### |
|
| 180 |
+# Capistrano deployment, read the documentation: # |
|
| 181 |
+# https://github.com/cantino/huginn/doc/manual/capistrano.md # |
|
| 182 |
+############################################################### |
|
| 182 | 183 |
|
| 183 | 184 |
#CAPISTRANO_DEPLOY_SERVER= |
| 184 | 185 |
#CAPISTRANO_DEPLOY_USER= |
+ 4
- 0
Procfile
@@ -16,6 +16,10 @@ jobs: bundle exec rails runner bin/threaded.rb |
||
| 16 | 16 |
# PRODUCTION # |
| 17 | 17 |
############################### |
| 18 | 18 |
|
| 19 |
+# You need to copy or link config/unicorn.rb.example to config/unicorn.rb for both production versions. |
|
| 20 |
+# Have a look at the deployment guides, if you want to set up huginn on your server: |
|
| 21 |
+# https://github.com/cantino/huginn/doc |
|
| 22 |
+ |
|
| 19 | 23 |
# Using the threaded worker (consumes less RAM but can run slower) |
| 20 | 24 |
# web: bundle exec unicorn -c config/unicorn.rb |
| 21 | 25 |
# jobs: bundle exec rails runner bin/threaded.rb |
+ 1
- 1
config/unicorn.rb.example
@@ -1,4 +1,4 @@ |
||
| 1 |
-wd = "/home/huginn/huginn" |
|
| 1 |
+wd = File.expand_path(File.join(File.dirname(__FILE__), '..')) |
|
| 2 | 2 |
|
| 3 | 3 |
app_path = wd |
| 4 | 4 |
|
+ 1
- 1
doc/README.md
@@ -8,7 +8,7 @@ |
||
| 8 | 8 |
|
| 9 | 9 |
### Manual installation |
| 10 | 10 |
|
| 11 |
-Manual installation which will guide through the steps to install Huginn on any Ubuntu 12.04/14.04 or Debian 6/7 server. |
|
| 11 |
+Manual installation instructions which will guide through the steps to install Huginn on any Ubuntu 12.04/14.04 or Debian 6/7 server. |
|
| 12 | 12 |
|
| 13 | 13 |
- [Install](manual/README.md) Requirements, directory structures and installation from source. |
| 14 | 14 |
- [Update](manual/update.md) Update your installation. |
+ 4
- 4
doc/docker/install.md
@@ -21,15 +21,15 @@ Getting Huginn up and running using docker is quick and painless once you have d |
||
| 21 | 21 |
1. Download [docker machine](https://docs.docker.com/machine/#installation) for your OS |
| 22 | 22 |
* Follow the installation instructions untill you can successfully run `docker ps` |
| 23 | 23 |
* Get the the IP of the VM running docker by running `docker-machine ls` |
| 24 |
-* Start your Huginn container using `docker run -it -p 5000:5000 cantino/huginn` |
|
| 25 |
-* Open Huginn in the browser [http://docker-machine ip:5000](http://<docker-machine ip>:5000) |
|
| 24 |
+* Start your Huginn container using `docker run -it -p 3000:3000 cantino/huginn` |
|
| 25 |
+* Open Huginn in the browser [http://docker-machine ip:3000](http://<docker-machine ip>:3000) |
|
| 26 | 26 |
* Log in to your Huginn instance using the username `admin` and password `password` |
| 27 | 27 |
|
| 28 | 28 |
#### Linux |
| 29 | 29 |
|
| 30 | 30 |
1. Install docker using the [install instructions](https://docs.docker.com/installation/) |
| 31 |
-* Start your Huginn container using `docker run -it -p 5000:5000 cantino/huginn` |
|
| 32 |
-* Open Huginn in the browser [http://localhost:5000](http://localhost:5000) |
|
| 31 |
+* Start your Huginn container using `docker run -it -p 3000:3000 cantino/huginn` |
|
| 32 |
+* Open Huginn in the browser [http://localhost:3000](http://localhost:3000) |
|
| 33 | 33 |
* Log in to your Huginn instance using the username `admin` and password `password` |
| 34 | 34 |
|
| 35 | 35 |
## Configuration and linking to a database container |
+ 1
- 1
doc/heroku/install.md
@@ -1,6 +1,6 @@ |
||
| 1 | 1 |
## Deploy to Heroku |
| 2 | 2 |
|
| 3 |
-### Important things to keep in mindd on the free plan |
|
| 3 |
+### Important things to keep in mind on the free plan |
|
| 4 | 4 |
|
| 5 | 5 |
* Heroku's [free plan](https://www.heroku.com/pricing) limits total runtime per day to 18 hours. This means that Huginn must sleep some of the time, and so recurring tasks will only run if their recurrence frequency fits within the free plan's awake time, which is 30 minutes. Therefore, we recommend that you only use the every 1 minute, every 2 minute, and every 5 minute Agent scheduling options. |
| 6 | 6 |
* When setting up Pingdom, set the `Check interval` to '60 minutes' so that your Huginn instance is up half the time. |
+ 9
- 7
doc/manual/installation.md
@@ -11,7 +11,7 @@ This is the official installation guide to set up a production server. To set up |
||
| 11 | 11 |
|
| 12 | 12 |
The following steps have been known to work. Please **use caution when you deviate** from this guide. Make sure you don't violate any assumptions Huginn makes about its environment. For example many people run into permission problems because they change the location of directories or run services as the wrong user. |
| 13 | 13 |
|
| 14 |
-If you find a bug/error in this guide please **submit a merge request**. |
|
| 14 |
+If you find a bug/error in this guide please **submit a pull request**. |
|
| 15 | 15 |
|
| 16 | 16 |
If not stated otherwise all commands should be run as user with sudo permissions or as root. |
| 17 | 17 |
|
@@ -136,7 +136,7 @@ You are done installing the database and can go back to the rest of the installa |
||
| 136 | 136 |
|
| 137 | 137 |
### Clone the Source |
| 138 | 138 |
|
| 139 |
- # We'll install Huginn into home directory of the user "huginn" |
|
| 139 |
+ # We'll install Huginn into the home directory of the user "huginn" |
|
| 140 | 140 |
cd /home/huginn |
| 141 | 141 |
|
| 142 | 142 |
# Clone Huginn repository |
@@ -209,7 +209,7 @@ Change the Unicorn config if needed, the [requirements.md](./requirements.md#uni |
||
| 209 | 209 |
|
| 210 | 210 |
**Important Note:** Make sure to edit both `.env` and `unicorn.rb` to match your setup. |
| 211 | 211 |
|
| 212 |
-**Note:** If you want to use HTTPS, see [Using HTTPS](#using-https) for the additional steps. |
|
| 212 |
+**Note:** If you want to use HTTPS, which is what we recommend, see [Using HTTPS](#using-https) for the additional steps. |
|
| 213 | 213 |
|
| 214 | 214 |
|
| 215 | 215 |
### Initialize Database |
@@ -225,7 +225,7 @@ Change the Unicorn config if needed, the [requirements.md](./requirements.md#uni |
||
| 225 | 225 |
|
| 226 | 226 |
When done you see `See the Huginn Wiki for more Agent examples! https://github.com/cantino/huginn/wiki` |
| 227 | 227 |
|
| 228 |
-**Note:** This will create an initial user, you can set the username and password by supplying it in environmental variables `SEED_USERNAME` and`SEED_PASSWORD` as seen below. If you don't set the password (and it is set to the default one) please wait with exposing Huginn to the public internet until the installation is done and you've logged into the server and changed your password. |
|
| 228 |
+**Note:** This will create an initial user, you can set the username and password by supplying it in environmental variables `SEED_USERNAME` and `SEED_PASSWORD` as seen below. If you don't set the password (and it is set to the default one) please wait with exposing Huginn to the public internet until the installation is done and you've logged into the server and changed your password. |
|
| 229 | 229 |
|
| 230 | 230 |
sudo -u huginn -H bundle exec rake db:seed RAILS_ENV=production SEED_USERNAME=admin SEED_PASSWORD=yourpassword |
| 231 | 231 |
|
@@ -235,7 +235,7 @@ When done you see `See the Huginn Wiki for more Agent examples! https://github. |
||
| 235 | 235 |
|
| 236 | 236 |
### Install Init Script |
| 237 | 237 |
|
| 238 |
-Huginn uses foreman to generate the init scripts based on a `Procfile` |
|
| 238 |
+Huginn uses [foreman](http://ddollar.github.io/foreman/) to generate the init scripts based on a `Procfile` |
|
| 239 | 239 |
|
| 240 | 240 |
Edit the `Procfile` and choose one of the suggested versions for production |
| 241 | 241 |
|
@@ -281,7 +281,7 @@ Remove the default nginx site, **if huginn is the only enabled nginx site**: |
||
| 281 | 281 |
|
| 282 | 282 |
sudo rm /etc/nginx/sites-enabled/default |
| 283 | 283 |
|
| 284 |
-**Note:** If you want to use HTTPS, replace the `huginn` Nginx config with `huginn-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details. |
|
| 284 |
+**Note:** If you want to use HTTPS, which is what we recommend, replace the `huginn` Nginx config with `huginn-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details. |
|
| 285 | 285 |
|
| 286 | 286 |
### Test Configuration |
| 287 | 287 |
|
@@ -307,7 +307,9 @@ Visit YOUR_SERVER in your web browser for your first Huginn login. The setup has |
||
| 307 | 307 |
|
| 308 | 308 |
**Enjoy!** |
| 309 | 309 |
|
| 310 |
-You can use `sudo start huginn` and `sudo stop huginn` to start and stop Huginn. |
|
| 310 |
+You can use `cd /home/huginn/huginn && sudo rake production:start` and `cd /home/huginn/huginn && sudo rake production:stop` to start and stop Huginn. |
|
| 311 |
+ |
|
| 312 |
+Be sure to read the section about how to [update](./update.md) your Huginn installation as well! You can also use [Capistrano](./capistrano.md) to keep your installation up to date. |
|
| 311 | 313 |
|
| 312 | 314 |
## Advanced Setup Tips |
| 313 | 315 |
|
+ 1
- 1
doc/manual/requirements.md
@@ -23,7 +23,7 @@ On the above unsupported distributions is still possible to install Huginn, and |
||
| 23 | 23 |
|
| 24 | 24 |
Huginn is developed for Unix operating systems. |
| 25 | 25 |
Huginn does **not** run on Windows and we have no plans of supporting it in the near future. |
| 26 |
-Please consider using a virtual machine to run Huginn. |
|
| 26 |
+Please consider using a virtual machine to run Huginn on Windows. |
|
| 27 | 27 |
|
| 28 | 28 |
## Ruby versions |
| 29 | 29 |
|
+ 2
- 0
doc/manual/update.md
@@ -1,5 +1,7 @@ |
||
| 1 | 1 |
# Update |
| 2 | 2 |
|
| 3 |
+You can also use [Capistrano](./capistrano.md) to keep your installation up to date. |
|
| 4 |
+ |
|
| 3 | 5 |
### 0. Ensure depencies are up to date |
| 4 | 6 |
|
| 5 | 7 |
``` |